﻿/*
-----------------------------------------------------------------------------
This source file is part of Cell Cloud.

Copyright (c) 2009-2012 Cell Cloud Team - cellcloudproject@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/

#ifndef CellAlignedAllocator_h
#define CellAlignedAllocator_h

// Now we're only including this within CellMemoryAllocatorConfig.h which is already in
// the prerequisites header (circlar reference)
//#include "CellPrerequisites.h"

namespace cell
{
/** \addtogroup Core
 *  @{
 */

/** \addtogroup Memory
 *  @{
 */

/** Class to provide aligned memory allocate functionality.
@remarks
	All SIMD processing are friendly with aligned memory, and some SIMD routines
	are designed for working with aligned memory only. If the data are intended to
	use SIMD processing, it's need to be aligned for better performance boost.
	In additional, most time cache boundary aligned data also lead to better
	performance even if didn't used SIMD processing. So this class provides a couple
	of functions for allocate aligned memory.
@par
	Anyways, in general, you don't need to use this class directly, Cell internally
	will take care with most SIMD and cache friendly optimisation if possible.
@par
	This isn't a "one-step" optimisation, there are a lot of underlying work to
	achieve performance boost. If you didn't know what are you doing or what there
	are going, just ignore this class.
@note
	This class intended to use by advanced user only.
*/
class _CellExport AlignedMemory
{
public:
	/** Allocate memory with given alignment.
	@param
		size The size of memory need to allocate.
	@param
		alignment The alignment of result pointer, must be power of two
		and in range [1, 128].
	@returns
		The allocated memory pointer.
	@par
		On failure, exception will be throw.
	*/
	static void* allocate(size_t size, size_t alignment);

	/** Allocate memory with default platform dependent alignment.
	@remarks
		The default alignment depend on target machine, this function
		guarantee aligned memory according with SIMD processing and
		cache boundary friendly.
	@param
		size The size of memory need to allocate.
	@returns
		The allocated memory pointer.
	@par
		On failure, exception will be throw.
	*/
	static void* allocate(size_t size);

	/** Deallocate memory that allocated by this class.
	@param
		p Pointer to the memory allocated by this class or <b>NULL</b> pointer.
	@par
		On <b>NULL</b> pointer, nothing happen.
	*/
	static void deallocate(void* p);
};

/** @} */
/** @} */
} // end namespace cell

#endif // CellAlignedAllocator_h
